// HTMLParser Library $Name: v1_6 $ - A java-based parser for HTML
// http://sourceforge.org/projects/htmlparser
// Copyright (C) 2004 Derrick Oswald
//
// Revision Control Information
//
// $Source: /cvsroot/htmlparser/htmlparser/src/org/htmlparser/Remark.java,v $
// $Author: derrickoswald $
// $Date: 2005/11/15 02:09:10 $
// $Revision: 1.4 $
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
//

package org.htmlparser;

/**
 * This interface represents a comment in the HTML document.
 */
public interface Remark extends Node {
	/**
	 * Returns the text contents of the comment tag.
	 * 
	 * @return The contents of the text inside the comment delimiters.
	 * @see #setText
	 */
	String getText();

	/**
	 * Sets the string contents of the node. If the text has the remark
	 * delimiters (&lt;!-- --&gt;), these are stripped off.
	 * 
	 * @param text
	 *            The new text for the node.
	 * @see #getText
	 */
	void setText(String text);

	//
	// Node interface
	//

	// public void accept (NodeVisitor visitor)
	// {
	// }
	//
	// public void collectInto (NodeList collectionList, NodeFilter filter)
	// {
	// }
	//
	// public NodeList getChildren ()
	// {
	// }
	//
	// public int getEndPosition ()
	// {
	// }
	//
	// public Node getParent ()
	// {
	// }
	//
	// public int getStartPosition ()
	// {
	// }
	//
	// public void setChildren (NodeList children)
	// {
	// }
	//
	// public void setEndPosition (int position)
	// {
	// }
	//
	// public void setParent (Node node)
	// {
	// }
	//
	// public void setStartPosition (int position)
	// {
	// }
	//
	// public String toHtml ()
	// {
	// }
	//
	// public String toPlainTextString ()
	// {
	// }
}
